@wordpress/keycodes
Advanced tools
Keycodes utilities for WordPress. Used to check for keyboard events across browsers/operating systems.
@wordpress/keycodes is a utility package that provides constants and helper functions for working with keyboard key codes. It is particularly useful for handling keyboard events in a consistent manner across different browsers and environments.
Keycode Constants
The package provides constants for common key codes, making it easier to reference and use them in your code without having to remember the numeric values.
const { ENTER, ESCAPE } = require('@wordpress/keycodes');
console.log(ENTER); // Outputs: 13
console.log(ESCAPE); // Outputs: 27isKeyboardEvent
This helper function checks if a given keyboard event matches a specified key. It simplifies the process of handling specific key events.
const { isKeyboardEvent } = require('@wordpress/keycodes');
const event = new KeyboardEvent('keydown', { keyCode: 13 });
console.log(isKeyboardEvent(event, 'enter')); // Outputs: truegetKeycodeByKey
This function returns the keycode for a given key name, providing a convenient way to map key names to their corresponding key codes.
const { getKeycodeByKey } = require('@wordpress/keycodes');
console.log(getKeycodeByKey('Enter')); // Outputs: 13The 'keycode' package provides a simple utility for converting between keyboard key names and their corresponding key codes. It offers similar functionality to @wordpress/keycodes but is more focused on the conversion aspect rather than providing a comprehensive set of utilities.
Mousetrap is a library for handling keyboard shortcuts in JavaScript. While it offers more advanced features for binding and handling keyboard shortcuts, it also includes utilities for working with key codes, making it a more feature-rich alternative to @wordpress/keycodes.
Hotkeys-js is a lightweight library for handling keyboard shortcuts. It provides a simple API for binding and unbinding keyboard events, and includes utilities for working with key codes. It is similar to @wordpress/keycodes but with a focus on keyboard shortcuts.
Keycodes utilities for WordPress, used to check the key pressed in events like onKeyDown. Contains keycodes constants for keyboard keys like DOWN, UP, ENTER, etc.
Install the module
npm install @wordpress/keycodes --save
This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for such language features and APIs, you should include the polyfill shipped in @wordpress/babel-preset-default in your code.
Check which key was used in an onKeyDown event:
import { DOWN, ENTER } from '@wordpress/keycodes';
// [...]
onKeyDown( event ) {
const { keyCode } = event;
if ( keyCode === DOWN ) {
alert( 'You pressed the down arrow!' );
} else if ( keyCode === ENTER ) {
alert( 'You pressed the enter key!' );
} else {
alert( 'You pressed another key.' );
}
}
Keycode for ALT key.
Keycode for BACKSPACE key.
Keycode for COMMAND/META key.
Keycode for CTRL key.
Keycode for DELETE key.
An object that contains functions to display shortcuts.
Usage
// Assuming macOS:
displayShortcut.primary( 'm' );
// "⌘M"
Type
WPModifierHandler<WPKeyHandler<string>>Keyed map of functions to display shortcuts.Return an array of the parts of a keyboard shortcut chord for display.
Usage
// Assuming macOS:
displayShortcutList.primary( 'm' );
// [ "⌘", "M" ]
Type
WPModifierHandler<WPKeyHandler<string[]>>Keyed map of functions to shortcut sequences.Keycode for DOWN key.
Keycode for END key.
Keycode for ENTER key.
Keycode for ESCAPE key.
Keycode for F10 key.
Keycode for HOME key.
Return true if platform is MacOS.
Parameters
Window?: window object by default; used for DI testing.Returns
boolean: True if MacOS; false otherwise.An object that contains functions to check if a keyboard event matches a predefined shortcut combination.
Usage
// Assuming an event for ⌘M key press:
isKeyboardEvent.primary( event, 'm' );
// true
Type
WPModifierHandler<WPEventKeyHandler>Keyed map of functions to match events.Keycode for LEFT key.
Object that contains functions that return the available modifier depending on platform.
Type
WPModifierHandler< ( isApple: () => boolean ) => WPModifierPart[]>Keycode for PAGEDOWN key.
Keycode for PAGEUP key.
An object that contains functions to get raw shortcuts.
These are intended for user with the KeyboardShortcuts.
Usage
// Assuming macOS:
rawShortcut.primary( 'm' );
// "meta+m""
Type
WPModifierHandler<WPKeyHandler<string>>Keyed map of functions to raw shortcuts.Keycode for RIGHT key.
Keycode for SHIFT key.
An object that contains functions to return an aria label for a keyboard shortcut.
Usage
// Assuming macOS:
shortcutAriaLabel.primary( '.' );
// "Command + Period"
Type
WPModifierHandler<WPKeyHandler<string>>Keyed map of functions to shortcut ARIA labels.Keycode for SPACE key.
Keycode for TAB key.
Keycode for UP key.
Keycode for ZERO key.
This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to npm and used by WordPress as well as other software projects.
To find out more about contributing to this package or Gutenberg as a whole, please read the project's main contributor guide.
FAQs
Keycodes utilities for WordPress. Used to check for keyboard events across browsers/operating systems.
We found that @wordpress/keycodes demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 23 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.
Security News
Sonar’s acquisition of Tidelift highlights a growing industry shift toward sustainable open source funding, addressing maintainer burnout and critical software dependencies.